Hybris UX Api
POST billingAccount
POST billingAccout
This operation allows billing account creation in the BSS system. The current implementation is for PR and JM customers. Billing Account will be created in CSG for PR and CERILLION for JM.
URL
http://[localhost]:[port]/ecom-ux/v1/{businessId}/billingAccountURL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (JM, PR) identifying the business unit. | Y |
Headers
| name | value | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| client-id | string | The client-id identifying the channel. Minimum characters: 5 | Y |
| client-secret | string | Password associated with the client-id. Minimum characters: 5 | Y |
| Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | N |
| channelId | string | Channel to business: default value: "ECOM". | N |
| lob | string | The Line of Business Identifier Ex: FIXED, PREPAID, POSTPAID | N |
Query Params
| name | value | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| sourceEPC | string | Y(JM) N(PR) |
Data Model - Request
| name | value | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| accountType | string | A categorization of an account, such as individual, joint, and so forth, whose instances share some of the same characteristics. Note: for flexibility we use a String here but an implementation may use an enumeration with a limited list of valid values Possible value for JM :"RES" | Y(JM) N/A(PR) |
| description | string | Detailed description of the party account | N(JM) N/A(PR) |
| name | string | Name of the account | N(JM,PR) |
| billStructure | object | The structure of the bill for party accounts (billing or settlement). | Y(JM) N/A(PR) |
| billStructure.presentationMedia[] | array of object | A list of bill presentation media ref or values | Y(JM) N/A(PR) |
| billStructure.presentationMedia[].id | string | Unique identifier of the bill presentation media. Ex E-Email,P-Paper Bill,N-Non-Paper based bills, E-Electronic Bills | N(JM) N/A(PR) |
| billStructure.presentationMedia[].name | string | A short descriptive name | Y(JM) N/A(PR) |
| contact[] | array of object | An individual or an organization used as a contact point for a given account and accessed via some contact medium. | Y(JM) N/A(PR) |
| contact[].contactName | string | A displayable name for that contact | Y(JM) N/A(PR) |
| contact[].contactType | string | Type of contact (primary, secondary...) | N(JM) N/A(PR) |
| contact[].partyRoleType | string | Identifies what kind of party role type is linked to the contact (a account manager...). | N(JM) N/A(PR) |
| contact[].contactMedium[] | array of object | Indicates the contact medium that could be used to contact the party. | Y(JM) N/A(PR) |
| contact[].contactMedium[].mediumType | string | Type of the contact medium, such as: email address, telephone number, postal address, BillingAddress | Y(JM) N/A(PR) |
| contact[].contactMedium[].preferred | boolean | If true, indicates that is the preferred contact medium | N(JM) N/A(PR) |
| contact[].contactMedium[].characteristic | object | Any additional characteristic(s) of this contact medium | Y(JM) N/A(PR) |
| contact[].contactMedium[].characteristic.city | string | City | N(JM) N/A(PR) |
| contact[].contactMedium[].characteristic.country | string | Country | N(JM) N/A(PR) |
| contact[].contactMedium[].characteristic.postCode | string | Postcode | N(JM) N/A(PR) |
| contact[].contactMedium[].characteristic.stree1 | string | Describes the street. For liberate, It will be the Address(Separated by comma). | N(JM) N/A(PR) |
| relatedParty[] | array of object | RelatedParty reference. A related party defines party or party role linked to a specific entity. | Y(JM,PR) |
| relatedParty[].id | string | Unique identifier Id of the EntityRef. | Y(JM,PR) |
| relatedParty[].name | string | Name of the EntityRef. | N(JM) N/A(PR) |
| relatedParty[].role | string | role played by the related party | N(JM,PR) |
| relatedParty[].'@type' | string | When sub-classing, this defines the sub-class entity name | N(JM) N/A(PR) |
| relatedParty[].'@referredType' | string | The actual type of the target instance when needed for disambiguation | N(PR) N/A(JM) |
| '@type' | string | When sub-classing, this defines the sub-class entity name. Type of this resource is: "BillingAccount" | N(JM,PR) |
| characteristic[] | array of object | Describes a given characteristic of an object or entity through a name/value pair. | Y(PR) N/A(JM) |
| characteristic[].name | string | Name of the characteristic. | Y(PR) N/A(JM) |
| characteristic[].value | any | The value of the characteristic | Y(PR) N/A(JM) |
characteristic
| name | value | description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| characteristic[].name="locationId" | string | Location Id | Y(PR) N/A(JM) | PR: { "value": "00921235400006", "name": "locationId"} |
| characteristic[].name="lob" | string | Lob | Y(PR) N/A(JM) | PR: { "value": "FIXED", "name": "lob" } |
Data Model Response
| name | value | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| accountNo | string | Billing account number | N(JM) N/A(PR) |
| id | string | Unique identifier of the account | N(PR) N/A(JM) |
| '@type' | string | When sub-classing, this defines the sub-class entity name. Type of this resource is: "BillingAccount" | N(PR) N/A(JM) |
| relatedParty[] | array of object | RelatedParty reference. A related party defines party or party role linked to a specific entity. | N(PR) N/A(JM) |
| relatedParty[].id | string | Unique identifier Id of the EntityRef. | N(PR) N/A(JM) |
| relatedParty[].name | string | Name of the EntityRef. | N(PR) N/A(JM) |
| relatedParty[].role | string | role played by the related party | N(PR) N/A(JM) |
| relatedParty[].'@referredType' | string | The actual type of the target instance when needed for disambiguation | N(PR) N/A(JM) |
| characteristic[] | array of object | Describes a given characteristic of an object or entity through a name/value pair. | N(PR) N/A(JM) |
| characteristic[].valueType | string | Data type of the value of the characteristic | N(PR) N/A(JM) |
| characteristic[].value | any | The value of the characteristic | N(PR) N/A(JM) |
| characteristic[].name | string | Name of the characteristic. | N(PR) N/A(JM) |
characteristic
| name | value | description | required (mandatory-Y, optional-N, Not applicable- N/A) | example |
|---|---|---|---|---|
| characteristic[].name="locationId" | string | Location Id | N(PR) N/A(JM) | PR:{ "valueType": "string", "value": "00917192000912", "name": "locationId" } |
Key considerations
For PR market
- Location ID (Customer House ID) is always linked with Customer Billing Account in CSG. One Location can have only one billing account.